6.1 新增外部组织架构
请求参数
Path: /api/v2/externalUserGroup/create
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 必须 |
Body
- 部分参数,如关联对象ID,需要通过在控制台手动获取,以Chrome浏览器为例,获取方式为F12打开“开发者工具”,在Network中找到对应对象的查询接口手动获取该对象的ID
- 用户目录ID,userDirectoryId获取方式,用“开发者工具”过滤请求 userDirectory/queryAll,打开控制台“业务管理”->“用户与角色”(原“用户管理”)页面,查看响应体数据获取对应用户目录的ID,也可以通过用户目录查询接口获取ID
- 认证策略ID,authComposeId获取方式,用“开发者工具”过滤请求 authCompose/queryAll,在控制台“业务管理”->“认证管理”->“认证策略”页面中打开您新增用户所属的用户目录,找到所属用户目录的认证策略查询接口,查看响应体数据获取对应的认证策略ID
- 用户策略ID,userPolicyId获取方式,用“开发者工具”过滤请求 userPolicy/queryUserPolicy,进入控制台“业务管理”->“策略管理”->“用户策略”页面,查看响应体数据获取所需策略的ID
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
userDirectoryId | string | 与userDirectoryName二选一 | 所属用户目录ID | userDirectoryId和userDirectoryName只传一个即可,都传时以userDirectoryId为准 | |
userDirectoryName | string | 与userDirectoryId二选一 | 所属用户目录名称 | userDirectoryId和userDirectoryName只传一个即可,都传时以userDirectoryId为准 | |
name | string | 必须 | 组织架构名字 | ||
path | string | 必须 | 所属组织架构 | ||
description | string | 非必须 | 描述 | ||
authComposeId | string | 非必须 | 认证策略ID | authComposeId和authComposeName只传一个即可,都传时以authComposeId为准 >=2.2.5:可以传空字符串代表策略为空,不传视为策略为空 <2.2.5:不支持传空字符串,不传为默认策略。 |
|
authComposeName | string | 非必须 | 认证策略名称 | >=2.2.10 SP3开始支持(2.2.12除外) authComposeId和authComposeName只传一个即可,都传时以authComposeId为准 >=2.2.5:可以传空字符串代表策略为空,不传视为策略为空 <2.2.5:不支持传空字符串,不传为默认策略。 |
|
userPolicyId | string | 非必须 | 用户策略ID | userPolicyId和userPolicyName只传一个即可,都传时以userPolicyId为准 >=2.2.5:可以传空字符串代表策略为空,不传视为策略为空 <2.2.5:不支持传空字符串,不传为默认策略。 |
|
userPolicyName | string | 非必须 | 用户策略名称 | >=2.2.10 SP3开始支持(2.2.12除外) userPolicyId和userPolicyName只传一个即可,都传时以userPolicyId为准 >=2.2.5:可以传空字符串代表策略为空,不传视为策略为空 <2.2.5:不支持传空字符串,不传为默认策略。 |
|
roleIdList | string[] | 非必须 | 角色ID列表 | roleIdList和roleNameList只传一个即可,都传时以roleIdList为准 | |
roleNameList | string[] | 非必须 | 角色名列表 | roleIdList和roleNameList只传一个即可,都传时以roleIdList为准 |
请求示例
{
"userDirectoryId": "d36ccb20-596a-11eb-a393-bbd9cb089321",
"name": "外部分组1",
"description": "1111",
"path": "/",
"authComposeId": "d36ccb20-596a-11eb-a393-bbd9cb0893d1",
"roleIdList": [ "7759f620-5583-11eb-880a-913383f106f2", "6559f620-5583-11eb-880a-913383f106f2"],
"userPolicyId": "default"
}
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 错误码,非0表示错误,具体含义请参考错误码定义 | ||
data | string[] | 必须 | 本地组织架构ID | ||
msg | string | 必须 | 描述信息 |
返回示例
{
"code": 0,
"data": ["092e4870-5b0e-11eb-a393-bbd9cb0893d1"],
"msg": "请求成功"
}
错误信息
错误提示 | 错误码 |
---|---|
请输入正确的所属组织架构格式:请以“/”开头,组织架构路径不能有连续“/”,且不能以“/”结尾 | 7201 |
所属组织架构为空时,名称必须为/ | 7201 |
用户目录不存在 | 77200001 |
认证策略不存在 | 77200001 |
认证策略不存在 | 77200004 |
用户策略不存在 | 77200001 |
用户策略不存在 | 77200004 |
参数检查出错 | 10000001 |
组织架构名称错误,不能存在/ | 77200005 |
所属组织架构路径层级不能超过32级 | 10000001 |
用户目录不存在 | 77200004 |
用户组织架构名(%s)已存在 | 77200005 |
操作失败 | 10000000 |